Allow to hide in which headers the struct is defined #725
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vermeeren
added
code
vermeeren
reviewed
Sep 18, 2021
jakobandersen
requested changes
Sep 18, 2021
|
Updated with the requested changes. |
When something like "doxygennamespace" is used, structures gain additional line about in which header they are defined. If the API simply serves as a generic description and no public headers are provided, this info is redundant. This can be worked around by manually by using "doxygenstruct" directive instead, but this can get messy quickly with large namespaces. Also, namespace description is lost. Allow to hide these lines by setting 'breathe_show_include' to 'False'. The default behavior stays unchanged. See breathe-doc#57.
|
And rebased on |
Merged
|
@rhssk Can you rebase this branch on master? @jakobandersen @vermeeren It looks like all requested changes were applied. Any further objections to merging this (after rebase is done)? |
jakobandersen
approved these changes
Nov 20, 2021
|
Thanks! Merged via rebase (87c6ca1 + parent). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When something like "doxygennamespace" is used, structures gain
additional line about in which header they are defined.
If the API simply serves as a generic description and no public headers
are provided, this info is redundant. This can be worked around
manually by using "doxygenstruct" directive instead, but this can get
messy quickly with large namespaces. Also, namespace description is
lost.
Allow to hide these lines by setting 'breathe_show_struct_include' to
'False'. The default behavior stays unchanged.
Fixes #57.